Skip to main content

Webhook: TASK_STEP_COMPLETED

Description​

The TASK_STEP_COMPLETED webhook is triggered when a task step is completed during task execution or an on-demand check-in. It helps external systems receive progress updates step by step instead of waiting until the whole task is completed.

Request Format​

The webhook sends an HTTP POST request with the following payload:

{
   "entityId": "1d63907b-93ed-4188-8b5d-99292fceaae9",
   "type": "TASK_STEP_COMPLETED",
   "createdAt": "2026-07-06T08:10:00.000Z",
   "userId": null,
   "data": {
      "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
      "scheduledTaskId": "22220000-0000-0000-0000-000000000000",
      "scheduledTaskHistoryId": 11,
      "executedTaskSummaryId": "33330000-0000-0000-0000-000000000000",
      "locationId": "44440000-0000-0000-0000-000000000000",
      "locationHistoryId": 22,
      "performerId": "55550000-0000-0000-0000-000000000000",
      "performerHistoryId": 33,
      "onDemandCheckIn": false,
      "step": {
         "id": "1d63907b-93ed-4188-8b5d-99292fceaae9",
         "name": "Step 1",
         "order": 0,
         "actualOrder": 1,
         "pointId": "66660000-0000-0000-0000-000000000000",
         "pointHistoryId": 44,
         "stepGroupId": "77770000-0000-0000-0000-000000000000",
         "state": "COMPLETED",
         "status": "SUCCESS",
         "startedAt": "2026-07-06T08:00:00.000Z",
         "endedAt": "2026-07-06T08:10:00.000Z"
      }
   }
}

Key Properties​

Top-Level Properties​

  • entityId: Unique identifier of the completed task step.
  • type: Specifies the webhook type (TASK_STEP_COMPLETED).
  • createdAt: Timestamp when the webhook was triggered in ISO 8601 format.
  • userId: User ID associated with the event when available. It can be null.
  • data: Contains task execution and step details.

Data Section​

  • organizationId: ID of the organization where the task step was completed.
  • scheduledTaskId: ID of the scheduled task.
  • scheduledTaskHistoryId: History version of the scheduled task.
  • executedTaskSummaryId: ID of the executed task summary.
  • locationId: ID of the location where the step was completed.
  • locationHistoryId: History version of the location.
  • performerId: ID of the user who performed the step.
  • performerHistoryId: History version of the performer.
  • onDemandCheckIn: Indicates whether the step was completed as part of an on-demand check-in.
  • step: Details of the completed task step.

Step Section​

  • id: Unique identifier of the step.
  • name: Step name.
  • order: Planned step order in the task.
  • actualOrder: Actual completion order.
  • pointId: ID of the related point, if available.
  • pointHistoryId: History version of the related point, if available.
  • stepGroupId: ID of the related step group, if available.
  • state: Step state, for example COMPLETED.
  • status: Step completion status, for example SUCCESS.
  • startedAt: Step start timestamp in ISO 8601 format.
  • endedAt: Step completion timestamp in ISO 8601 format.

Use Cases​

  1. Track task execution progress in an external system.
  2. Trigger automation immediately after a required point or checklist step is completed.
  3. Monitor on-demand check-ins and scheduled task execution with the same integration flow.